GET /services/{serviceNo}/realTimeBalances
Key considerations for CWC (flow markets)
- This is implemented for Postpaid and Prepaid lines. This is Not applicable for Fixed.
- to retrieve data from Liberate/cerillion. Then service number need to be provided without country code and BU code for all BUs excluding JM and BB. For Jamaica and Barbados, the serviceNumber should be sent including BU code (i.e 876 for JM and 246 for BB).
- for CWC Liberate postpaid, data will be retrieved from Liberate and Limeware for BUs(JM,VC,LC,GD,AG,TC,KY,AI,KN,MS,VG,DM). Limeware response gives data balances/usage whereas liberate provides remaining balances/usage. Input parameters are service/subscriber number and account number.
- for CWC cerillion postpaid, data will be retrieved from Cerillion and Limeware for BUs(BB,BS). Limeware response gives data balances/usage whereas cerillion provides remaining balances/usage. Input parameters are service/subscriber number.
- for CWC prepaid, data will be retrieved from Limeware for BUs(JM,VC,LC,GD,AG,TC,KY,AI,KN,MS,VG,DM,BB,CW). Limeware response gives all the prepaid balances/usage. Input parameters are service/subscriber number.
For sample responses refer below examples:
- CWC Liberate response
- CWC Cerillion response
- CWC Limeware response
Request
This section defines all the possible data structures sent by the client when consuming the method.
URL
http://[localhost]:[port]/bot-ux/{version}/{businessId}/services/{serviceNo}/realTimeBalances
note: here version is V2.
URI Parameter
| Name | Type | Description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | M |
| serviceNo | string | Service number or subscriber number | M |
Query Parameter
| Name | Type | Description | required |
|---|
| relatedParty.id | string | Account number | O (only Mandatory for Postpaid Liberate Accounts) |
| Name | Type | Description | required |
|---|
| X-Correlation-ID | string | This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers.</br>Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b </br> | O |
| lob | String | TheLine of Business Identifier currently available are:<br>Enum: PREPAID , POSTPAID, FIXED<br> | M |
| Name | Type | Description | required |
|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | M |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | M |